﻿#region License
//
// Author: Pål Fossmo <pal@fossmo.net>
// Copyright (c) 2008 Pål Fossmo
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion

namespace TreeFrog.Rename
{
    /// <summary>
    /// Represents properties used by the rename service.
    /// </summary>
    public interface IRename
    {
        /// <summary>
        /// Gets or sets the name of the directory to replace.
        /// </summary>
        /// <value>The directory name to replace.</value>
        string DirectoryToReplace { get; set; }
        /// <summary>
        /// Gets or sets the name of the working directory.
        /// </summary>
        /// <value>The working directory name.</value>
        string WorkingDirectory { get; set; }
        /// <summary>
        /// Gets or sets the name of the new directory.
        /// </summary>
        /// <value>The new directory name.</value>
        string NewDirectory { get; set; }
        /// <summary>
        /// Gets or sets the text to replace.
        /// </summary>
        /// <value>The text to replace.</value>
        string TextToReplace { get; set; }
        /// <summary>
        /// Gets or sets the text to replace <see cref="TextToReplace"/>.
        /// </summary>
        /// <value>The new text.</value>
        string NewText { get; set; }
    }
}
